/*
 * Albareth - an action roleplaying game.
 * Copyright (C) 2008 Jens Anuth
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 *   02110-1301, USA.
 * 
 * $Id: MenuView.java 35 2008-05-05 14:16:37Z jens464 $
*/
package albareth.frontend.slick.ui;

import org.newdawn.slick.Graphics;

public interface MenuView
{
    public int getItemsPerPage(BasicMenuFrame menu);
    
    public int getRowsPerPage(BasicMenuFrame menu);

    /**
     * @return the page-relative item index (page offset) at pixel x|y.
     *         e.g.: at x|y there is the n-th item of the current page.
     *         the first item of a page has index 0.
     */
    public int getItemPageOffsetAt(BasicMenuFrame menu, int x, int y);

    /**
     * @return the x pixel-position of the item with given page-relative index.
     */
    public int getItemXPosition(BasicMenuFrame menu, int itemPageOffset);

    /**
     * @return the y pixel-position of the item with given page-relative index.
     */
    public int getItemYPosition(BasicMenuFrame menu, int itemPageOffset);

    public void renderMenuItem(BasicMenuFrame menu, MenuItem item, Graphics g,
            int screenX, int screenY, boolean highlighted);
}
